Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits > Class Template Reference

TextBoxConceptImpl is an abstract class for implementing the Text Box node concept. More...

#include <kanzi/ui/node/concept/text_box.hpp>

Inheritance diagram for kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >:
[legend]

Public Member Functions

void backspaceAtCursor ()
 Deletes a character using backspace. More...
 
void backspaceWordAtCursor ()
 Deletes the characters between the cursor position and the closest word boundary using backspace. More...
 
void cancelTextComposition ()
 Tells a Text Box node to cancel text composition. More...
 
void clearSelection ()
 Clears the current selection. More...
 
void commitCompositionText ()
 Tells a Text Box node to commit the composition text. More...
 
void deleteAtCursor ()
 Deletes a character using delete. More...
 
void deleteSelection ()
 Erases selected text. More...
 
void deleteText (size_t begin, size_t end)
 Moves the cursor to position begin and erases UTF-8 characters between positions a\ begin and end. More...
 
void deleteWordAtCursor ()
 Deletes the characters between the cursor position and the word boundary that follows the cursor. More...
 
void enterEditingState ()
 Tells a Text Box node to enter the editing state. More...
 
string getCompositionText () const
 Returns the composition text. More...
 
string getDisplayText () const
 Returns a displayable text that Kanzi constructs from the text buffer of the input manipulator owned by the Text Box node, using the kanzi::EchoMode of the Text Box. More...
 
float getLineHeight ()
 Returns the line height of the font that the Text Box node uses. More...
 
string getSelectedText ()
 Returns the text that is currently selected in the Text Box node. More...
 
size_t getSelectionEnd () const
 Returns the end index for the current selection. More...
 
optional< size_t > getSelectionStart () const
 Returns the start index for the current text selection, or nullopt if no text is selected. More...
 
bool hasSelection () const
 Returns whether any of the text in a Text Box node is selected. More...
 
void insertText (size_t position, string_view text)
 Moves the cursor to a given position and inserts text to that position. More...
 
void insertTextAtCursor (string_view text)
 Inserts text in a Text Box node at the cursor position and moves the cursor forward. More...
 
void leaveEditingState ()
 Tells a Text Box node to leave the editing state. More...
 
void moveCursorBackward (size_t distance)
 Moves the cursor backward in the text buffer of a Text Box node. More...
 
void moveCursorBackward ()
 Moves the cursor backward by one character. More...
 
void moveCursorForward (size_t distance)
 Moves the cursor forward in the text buffer of a Text Box node. More...
 
void moveCursorForward ()
 Moves the cursor forward by one character. More...
 
void moveCursorHome ()
 Moves the cursor to the beginning of the text buffer of a Text Box node. More...
 
void moveCursorToEnd ()
 Moves the cursor to the end of the text buffer of a Text Box node. More...
 
void moveCursorToNextWord ()
 Moves the cursor to the next word. More...
 
void moveCursorToPreviousWord ()
 Moves the cursor to the previous word. More...
 
void moveSelectionEndBackward (size_t distance)
 Moves the end of text selection backward by a given number of characters in the text buffer of a Text Box node. More...
 
void moveSelectionEndBackward ()
 Moves the end of the text selection backward by one character. More...
 
void moveSelectionEndForward (size_t distance)
 Moves the end of text selection forward by a given number of characters in the text buffer of a Text Box node. More...
 
void moveSelectionEndForward ()
 Moves the end of the text selection forward by one character. More...
 
void moveSelectionEndpointBackward (size_t steps)
 Moves the active selection end-point backward with steps passed as argument. More...
 
void moveSelectionEndpointForward (size_t steps)
 Moves the active selection end-point forward with steps passed as argument. More...
 
void moveSelectionEndpointToBack ()
 Moves the active selection end-point to the end of the text. More...
 
void moveSelectionEndpointToFront ()
 Moves the active selection end-point to the front. More...
 
void moveSelectionEndpointToNextWord ()
 Moves the active selection end-point forward to the previous word boundary. More...
 
void moveSelectionEndpointToPreviousWord ()
 Moves the active selection end-point backward to the previous word boundary. More...
 
void moveSelectionEndToNextWord ()
 Moves the end of the text selection forward to the next word. More...
 
void moveSelectionEndToPreviousWord ()
 Moves the end of the text selection backward to the previous word. More...
 
void moveSelectionStartBackward (size_t distance)
 Moves the start of text selection backward by a given number of characters in the text buffer of a Text Box node. More...
 
void moveSelectionStartBackward ()
 Moves the beginning of the text selection backward by one character. More...
 
void moveSelectionStartForward (size_t distance)
 Moves the selection start forward in the text buffer of a Text Box node. More...
 
void moveSelectionStartForward ()
 Moves the beginning of the text selection forward by one character. More...
 
void moveSelectionStartToNextWord ()
 Moves the beginning of the text selection forward to the next word. More...
 
void moveSelectionStartToPreviousWord ()
 Moves the beginning of the text selection backward to the previous word. More...
 
void notifyPostPrepareTextFormat (bool completeRelayoutingExecuted)
 Kanzi calls this function every time it successfully completes the prepareTextFormat function. More...
 
void selectAll ()
 Selects all the content in a Text Box node. More...
 
void selectText (size_t from, size_t to)
 Selects the text between given indexes (cursor positions). More...
 
void selectWordAt (size_t characterPosition)
 Selects the word at the specified character position. More...
 
void selectWordAtCursor ()
 Selects the word at the current cursor position. More...
 
void setSelectionEnd (size_t index)
 Sets the end index for the current selection. More...
 
void setSelectionStart (size_t index)
 Sets the start index for the current selection. More...
 
Properties
BrushSharedPtr getSelectionBackgroundBrush () const
 Returns the value of the SelectionBackgroundBrushProperty. More...
 
void setSelectionBackgroundBrush (BrushSharedPtr value)
 Sets the value of the SelectionBackgroundBrushProperty. More...
 
BrushSharedPtr getSelectionForegroundBrush () const
 Returns the value of the SelectionForegroundBrushProperty. More...
 
void setSelectionForegroundBrush (BrushSharedPtr value)
 Sets the value of the SelectionForegroundBrushProperty. More...
 
BrushSharedPtr getCompositionBackgroundBrush () const
 Returns the value of the CompositionTextBackgroundBrushProperty. More...
 
void setCompositionBackgroundBrush (BrushSharedPtr value)
 Sets the value of the CompositionTextBackgroundBrushProperty. More...
 
BrushSharedPtr getCompositionForegroundBrush () const
 Returns the value of the CompositionTextForegroundBrushProperty. More...
 
void setCompositionForegroundBrush (BrushSharedPtr value)
 Sets the value of the CompositionTextForegroundBrushProperty. More...
 
size_t getCursorPosition ()
 Returns the value of the CursorPositionProperty. More...
 
void setCursorPosition (size_t value)
 Sets the value of the CursorPositionProperty. More...
 
bool isReadOnly () const
 Returns the value of the ReadOnlyProperty. More...
 
void setReadOnly (bool value)
 Sets the value of the ReadOnlyProperty. More...
 
size_t getMaximumTextLength () const
 Returns the value of the MaximumTextLengthProperty. More...
 
void setMaximumTextLength (size_t value)
 Sets the value of the MaximumTextLengthProperty. More...
 
PrefabTemplateSharedPtr getCursorPrefab () const
 Returns the value of the CursorPrefabProperty. More...
 
void setCursorPrefab (const PrefabTemplateSharedPtr &prefab)
 Sets the value of the CursorPrefabProperty. More...
 
PrefabTemplateSharedPtr getSelectionStartPrefab () const
 Returns the value of the SelectionStartPrefabProperty. More...
 
void setSelectionStartPrefab (const PrefabTemplateSharedPtr &prefab)
 Sets the value of the SelectionStartPrefabProperty. More...
 
PrefabTemplateSharedPtr getSelectionEndPrefab () const
 Returns the value of the SelectionEndPrefabProperty. More...
 
void setSelectionEndPrefab (const PrefabTemplateSharedPtr &prefab)
 Sets the value of the SelectionEndPrefabProperty. More...
 
PrefabTemplateSharedPtr getTextHintPrefab () const
 Returns the value of the TextHintPrefabProperty. More...
 
void setTextHintPrefab (const PrefabTemplateSharedPtr &prefab)
 Sets the value of the TextHintPrefabProperty. More...
 
bool isHideTextHintWhenFocused () const
 Returns the value of the HideTextHintWhenEditingProperty. More...
 
void setHideTextHintWhenFocused (bool value)
 Sets the value of the HideTextHintWhenEditingProperty. More...
 
EchoMode getEchoMode () const
 Returns the value of the EchoModeProperty. More...
 
void setEchoMode (const EchoMode &mode)
 Sets the value of the EchoModeProperty. More...
 
InputType getInputType () const
 Returns the value of the InputTypeProperty. More...
 
void setInputType (const InputType &inputType)
 Sets the value of the InputTypeProperty. More...
 
EditMode getEditMode () const
 Returns the value of the EditModeProperty. More...
 
void setEditMode (const EditMode &mode)
 Sets the value of the EditModeProperty. More...
 
bool isEditing () const
 Returns the value of the IsEditingProperty. More...
 
bool isComposingText () const
 Returns the value of the IsComposingTextProperty. More...
 
size_t getCharacterCount ()
 Returns the value of the CharacterCountProperty. More...
 
size_t getWordCount ()
 Returns the value of the WordCountProperty. More...
 
int getPasswordEchoTimeout () const
 Returns the value of the PasswordEchoTimeoutProperty. More...
 
void setPasswordEchoTimeout (int timeout)
 Sets the value of the PasswordEchoTimeoutProperty. More...
 
string getPasswordMaskingCharacter () const
 Returns the value of the PasswordMaskingCharacterProperty. More...
 
void setPasswordMaskingCharacter (string_view passwordMask)
 Sets the value of the PasswordMaskingCharacterProperty. More...
 
InputMethodAction getInputMethodAction () const
 Returns the value of the InputMethodActionProperty. More...
 
void setInputMethodAction (InputMethodAction label)
 Sets the value of the InputMethodActionProperty. More...
 
TextKeyNavigationDirection getTextKeyNavigationDirection () const
 Returns the value of the TextKeyNavigationDirectionProperty. More...
 
void setTextKeyNavigationDirection (TextKeyNavigationDirection direction)
 Sets the value of the TextKeyNavigationDirectionProperty. More...
 
- Public Member Functions inherited from kanzi::TextBoxConcept
 KZ_METACLASS_PROPERTY_TYPE (CompositionTextProperty)
 
- Public Member Functions inherited from kanzi::TextConceptImpl< TDerivedClass >
ColorRGBA getFontColor () const
 Gets the value of the FontColorProperty. More...
 
MaterialSharedPtr getFontMaterial () const
 Gets the value of the FontMaterialProperty. More...
 
bool getHorizontalFit () const
 Gets the value of the HorizontalFitProperty. More...
 
Vector2 getHorizontalFitScaleLimits () const
 Gets the value of the HorizontalFitScaleLimitsProperty. More...
 
Vector2 getHorizontalPadding () const
 Gets the value of HorizontalPaddingProperty. More...
 
string getOverflow () const
 Gets the value of the OverflowProperty. More...
 
bool getRemoveSideBearings () const
 Gets the value of the RemoveSideBearingsProperty. More...
 
string getText () const
 Gets the value of TextProperty. More...
 
TextFormat::TextHorizontalAlignment getTextHorizontalAlignment () const
 Gets the value of the TextHorizontalAlignmentProperty. More...
 
TextFormat::TextVerticalAlignment getTextVerticalAlignment () const
 Gets the value of the TextVerticalAlignmentProperty. More...
 
TextFormat::Truncation getTruncation () const
 Gets the value of the TruncationProperty. More...
 
TextFormat::TruncationDirection getTruncationDirection () const
 Gets the value of the TruncationDirectionProperty. More...
 
Vector2 getVerticalPadding () const
 Gets the value of VerticalPaddingProperty. More...
 
void setFontColor (ColorRGBA value)
 Sets the value of the FontColorProperty. More...
 
void setFontMaterial (MaterialSharedPtr value)
 Sets the value of the FontMaterialProperty. More...
 
void setHorizontalFit (bool value)
 Sets the value of the HorizontalFitProperty. More...
 
void setHorizontalFitScaleLimits (Vector2 value)
 Sets the value of the HorizontalFitScaleLimitsProperty. More...
 
void setHorizontalPadding (Vector2 value)
 Sets the value of HorizontalPaddingProperty. More...
 
void setOverflow (string_view value)
 Sets the value of the OverflowProperty. More...
 
void setRemoveSideBearings (bool value)
 Sets the value of the RemoveSideBearingsProperty. More...
 
void setText (string value)
 Sets the value of TextProperty. More...
 
void setTextHorizontalAlignment (TextFormat::TextHorizontalAlignment value)
 Sets the value of the TextHorizontalAlignmentProperty. More...
 
void setTextVerticalAlignment (TextFormat::TextVerticalAlignment value)
 Sets the value of the TextVerticalAlignmentProperty. More...
 
void setTruncation (TextFormat::Truncation value)
 Sets the value of the TruncationProperty. More...
 
void setTruncationDirection (TextFormat::TruncationDirection value)
 Sets the value of the TruncationDirectionProperty. More...
 
void setVerticalPadding (Vector2 value)
 Sets the value of VerticalPaddingProperty. More...
 
virtual ~TextConceptImpl ()=default
 Destructor. More...
 
- Public Member Functions inherited from kanzi::TextConcept
virtual ~TextConcept ()=default
 Destructor. More...
 
- Public Member Functions inherited from kanzi::FontStyleConceptImpl< TDerivedClass >
float getCharacterSpacing () const
 Gets the value of the FontStyleConcept::CharacterSpacingProperty property. More...
 
float getFixedCharacterWidth () const
 Gets the value of the FontStyleConcept::FixedCharacterWidthProperty property. More...
 
float getFontSize () const
 Gets the value of the FontStyleConcept::SizeProperty property. More...
 
FontStyle getFontStyle () const
 Gets the value of the FontStyleConcept::StyleProperty property. More...
 
FontWeight getFontWeight () const
 Gets the value of the FontStyleConcept::WeightProperty property. More...
 
bool getFractionalCharacterWidth () const
 Gets the value of the FontStyleConcept::FractionalCharacterWidthProperty property. More...
 
FontHintingPreference getHintingPreference () const
 Gets the value of HintingPreferenceProperty. More...
 
float getLineSpacing () const
 Gets the value of the FontStyleConcept::LineSpacingProperty property. More...
 
FontRuntimeSharedPtr getRuntimeFont ()
 Gets the runtime font. More...
 
bool getSnapCharacterToPixel () const
 Gets the value of the FontStyleConcept::SnapCharacterToPixelProperty property. More...
 
void releaseRuntimeFont ()
 Releases the runtime font that is held by FontStyleConceptImpl. More...
 
void setCharacterSpacing (float value)
 Sets the value of the FontStyleConcept::CharacterSpacingProperty property. More...
 
void setFixedCharacterWidth (float value)
 Sets the value of the FontStyleConcept::FixedCharacterWidthProperty property. More...
 
void setFontSize (float value)
 Sets the value of the FontStyleConcept::SizeProperty property. More...
 
void setFontStyle (FontStyle style)
 Sets the value of the FontStyleConcept::StyleProperty property. More...
 
void setFontWeight (FontWeight weight)
 Sets the value of the FontStyleConcept::WeightProperty property. More...
 
void setFractionalCharacterWidth (bool enable)
 Sets the value of the FontStyleConcept::FractionalCharacterWidthProperty property. More...
 
void setHintingPreference (FontHintingPreference hintingPreference)
 Sets the value of HintingPreferenceProperty. More...
 
void setLineSpacing (float value)
 Sets the value of the FontStyleConcept::LineSpacingProperty property. More...
 
void setSnapCharacterToPixel (bool enable)
 Sets the value of the FontStyleConcept::SnapCharacterToPixelProperty property. More...
 
bool updateRuntimeFont ()
 Updates the runtime font. More...
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::TextBoxConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::TextConceptImpl< TDerivedClass >
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::TextConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::FontStyleConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Protected Member Functions

vector< pair< float, float > > calculateCompositionHighlightCoordinates () const
 Calculates the individual composition text highlight coordinates of a given Text Box node state. More...
 
vector< pair< float, float > > calculateSelectionCoordinates () const
 Calculates the individual selection coordinates of a given Text Box node state. More...
 
void censorRevealedCharacter ()
 Censors the revealed character in password echo mode. More...
 
TextConcept::TextFormatParameters createTextFormatParameters (float width, float height) const
 Creates the parameters that are needed for initializing the TextFormat of a Text Box node. More...
 
void deleteCharactersAtCursor (int count)
 Deletes a given number of characters at cursor position. More...
 
pair< float, float > getSelectionEndPoints () const
 Returns the selection end point coordinates from the given Text Box node state. More...
 
string getTextForFormatting () const
 Returns the m_displayText with added explicit directionality marker if it is a password text. More...
 
void handleBackspaceAtCursor (const TextBoxConcept::EraseCharactersMessageArguments &args)
 Handler for TextBoxConcept::BackspaceAtCursorMessage. More...
 
void handleBackspaceWordAtCursor (const TextBoxConcept::EraseCharactersMessageArguments &args)
 Handler for TextBoxConcept::BackspaceWordAtCursorMessage. More...
 
void handleCancelTextComposition (TextBoxConcept::TextCompositionStateMessageArguments &args)
 Handler for TextBoxConcept::CancelTextCompositionMessage. More...
 
void handleClearSelection (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::ClearSelectionMessage. More...
 
void handleCommitCompositionText (TextBoxConcept::TextCompositionStateMessageArguments &args)
 Handler for TextBoxConcept::CommitCompositionTextMessage. More...
 
void handleDeleteAtCursor (const TextBoxConcept::EraseCharactersMessageArguments &args)
 Handler for TextBoxConcept::DeleteAtCursorMessage. More...
 
void handleDeleteSelectionMessage (TextBoxConcept::DeleteSelectionMessageArguments &args)
 Handler for TextBoxConcept::DeleteSelectionMessage. More...
 
void handleDeleteTextMessage (TextBoxConcept::TextRangeMessageArguments &args)
 Handler for TextBoxConcept::DeleteTextMessage. More...
 
void handleDeleteWordAtCursor (const TextBoxConcept::EraseCharactersMessageArguments &args)
 Handler for TextBoxConcept::DeleteWordAtCursorMessage. More...
 
void handleEnterEditing (TextBoxConcept::ModifyEditingStateMessageArguments &args)
 Handler for TextBoxConcept::EnterEditingStateMessage. More...
 
void handleInsertTextAtCursor (const TextBoxConcept::TextContentMessageArguments &args)
 Handler for TextBoxConcept::InsertTextAtCursorMessage. More...
 
void handleInsertTextMessage (TextBoxConcept::TextInsertionMessageArguments &args)
 Handler for TextBoxConcept::InsertTextMessage. More...
 
void handleLeaveEditing (TextBoxConcept::ModifyEditingStateMessageArguments &args)
 Handler for TextBoxConcept::LeaveEditingStateMessage. More...
 
void handleMoveCursorBackward (const TextBoxConcept::MoveCursorMessageArguments &args)
 Handler for TextBoxConcept::MoveCursorBackwardMessage. More...
 
void handleMoveCursorForward (const TextBoxConcept::MoveCursorMessageArguments &args)
 Handler for TextBoxConcept::MoveCursorForwardMessage. More...
 
void handleMoveCursorHome (const TextBoxConcept::MoveCursorMessageArguments &args)
 Handler for TextBoxConcept::MoveCursorHomeMessage. More...
 
void handleMoveCursorToEnd (const TextBoxConcept::MoveCursorMessageArguments &args)
 Handler for TextBoxConcept::MoveCursorToEndMessage. More...
 
void handleMoveCursorToNextWord (const TextBoxConcept::MoveCursorMessageArguments &args)
 Handler for TextBoxConcept::MoveCursorToNextWordMessage. More...
 
void handleMoveCursorToPreviousWord (const TextBoxConcept::MoveCursorMessageArguments &args)
 Handler for TextBoxConcept::MoveCursorToPreviousWordMessage. More...
 
void handleMoveSelectionEndBackward (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionEndBackwardMessage. More...
 
void handleMoveSelectionEndForward (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionEndForwardMessage. More...
 
void handleMoveSelectionEndToNextWordMessage (TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionEndToNextWordMessage. More...
 
void handleMoveSelectionEndToPreviousWordMessage (TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionEndToPreviousWordMessage. More...
 
void handleMoveSelectionStartBackward (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionStartBackwardMessage. More...
 
void handleMoveSelectionStartForward (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionStartForwardMessage. More...
 
void handleMoveSelectionStartToNextWordMessage (TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionStartToNextWordMessage. More...
 
void handleMoveSelectionStartToPreviousWordMessage (TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::MoveSelectionStartToPreviousWordMessage. More...
 
void handleSelectAll (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::SelectAllMessage. More...
 
void handleSelectTextMessage (TextBoxConcept::TextRangeMessageArguments &args)
 Handler for TextBoxConcept::SelectTextMessage. More...
 
void handleSelectToEnd (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::SelectToEndMessage. More...
 
void handleSelectToHome (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::SelectToHomeMessage. More...
 
void handleSelectWordAtCursor (const TextBoxConcept::ModifySelectionMessageArguments &args)
 Handler for TextBoxConcept::SelectWordAtCursorMessage. More...
 
bool hitTestAfterSelectionEnd (Vector2 point) const
 Checks whether the point is positioned after the point where text selection ends. More...
 
bool hitTestAheadSelectionStart (Vector2 point) const
 Checks whether the point is positioned ahead of the point where text selection starts. More...
 
bool hitTestSelectionEnd (Vector2 point) const
 Checks whether the point is on the selection ending point surroundings. More...
 
bool hitTestSelectionStart (Vector2 point) const
 Checks whether the point is on the selection starting point surroundings. More...
 
void initialize ()
 TextBoxConceptImpl specific initialization. More...
 
void moveCursorToPoint (const Vector2 &point)
 Moves the cursor to a given point. More...
 
void onAboutToLoseFocus (FocusManager::PreFocusMessageArguments &args)
 Handler for FocusManager::AboutToLoseFocusMessage. More...
 
void onCompositionTextChanged (TextInputManipulator::TextCompositionStateMessageArguments &)
 Handles TextInputManipulator::CompositionTextChangedMessage. More...
 
void onCompositionTextCommitted (TextInputManipulator::TextCompositionStateMessageArguments &)
 Handles TextInputManipulator::CompositionTextCommittedMessage. More...
 
void onCursorMoved (TextInputManipulator::CursorMovedMessageArguments &args)
 Handles TextInputManipulator::CursorMovedMessage. More...
 
void onDetached () override
 Overrides Node::onDetached(). More...
 
void onEchoModeChanged ()
 Handles the change of the kanzi::EchoMode. More...
 
void onFocusGained (FocusManager::PostFocusMessageArguments &args)
 Handler for FocusManager::FocusGainedMessage. More...
 
void onFocusLost (FocusManager::PostFocusMessageArguments &args)
 Handler for FocusManager::FocusLostMessage. More...
 
void onInputAction (TextInputManipulator::InputMethodActionMessageArguments &)
 Handles TextInputManipulator::InputMethodActionMessage. More...
 
void onInputMethodAvailableChanged (TextInputManipulator::InputMethodAvailableChangedMessageArguments &)
 Handles TextInputManipulator::InputMethodAvailableChangedMessage. More...
 
void onInputMethodsDisconnected (TextInputManipulator::InputMethodsDisconnectedMessageArguments &)
 Handles TextInputManipulator::InputMethodDeactivatedMessage. More...
 
void onInputTypeChanged (TextInputManipulator::InputTypeChangedMessageArguments &)
 Handles TextInputManipulator::InputTypeChangedMessage. More...
 
void onInputTypePropertyChanged ()
 Handles the change of the kanzi::InputType. More...
 
void onMultiClick (const Vector2 &clickPoint)
 Handles the multi-click gesture on a node. More...
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Node::onPropertyChanged implementation. More...
 
void onPanFinished ()
 Handles pan finishing. More...
 
void onPanMoved (Vector2 point)
 Handles the pan gesture, to drag the cursors including the selection cursors. More...
 
void onPanStarted (Vector2 clickPoint)
 Handles the click begin. More...
 
void onReadOnlyStateChanged (TextInputManipulator::ReadOnlyStateChangedMessageArguments &)
 Handles TextInputManipulator::ReadOnlyStateChangedMessage. More...
 
void onSelectionChanged (TextInputManipulator::SelectionChangedMessageArguments &args)
 Handles TextInputManipulator::SelectionChangedMessage. More...
 
void onTextChanged (TextInputManipulator::TextChangedMessageArguments &)
 Handles TextInputManipulator::TextChangedMessage. More...
 
void onTextCompositionCanceled (TextInputManipulator::TextCompositionStateMessageArguments &)
 Handles TextInputManipulator::TextCompositionCanceledMessage. More...
 
void onTextPropertyChanged ()
 Handles the update of the TextProperty. More...
 
void refreshTextHint ()
 Refresh text hint visibility. More...
 
void reloadCursor ()
 Reloads from the CursorPrefabProperty the prefab template that defines the appearance of the cursor. More...
 
void reloadSelectionEnd ()
 Reloads from the SelectionEndPrefabProperty the prefab template that defines the appearance of the selection handle at the end of text selection. More...
 
void reloadSelectionStart ()
 Reloads from the SelectionStartPrefabProperty the prefab template that defines the appearance of the selection handle at the beginning of text selection. More...
 
void reloadTextHint ()
 Reloads from the TextHintPrefabProperty the prefab template for showing placeholder content when the TextBox node is empty. More...
 
void setRevealLastInsertedCharacter (bool reveal)
 Sets whether to reveal the last inserted character in password echo mode. More...
 
void startEditing ()
 Tells a Text Box node to enter the editing state. More...
 
 TextBoxConceptImpl (Domain *domain, string_view name)
 Constructor. More...
 
void updateCharacterCount ()
 Updates the value of the CharacterCountProperty. More...
 
void updateCompositionText ()
 Updates the value of the CompositionTextProperty. More...
 
void updateDisplayText ()
 Updates the value of the DisplayTextProperty. More...
 
void updateDraggingStatus ()
 Updates the dragging flags: More...
 
void updateWordCount ()
 Updates the value of the WordCountProperty. More...
 
- Protected Member Functions inherited from kanzi::TextBoxConcept
void drawRectangle (Renderer3D &renderer, const Matrix4x4 &transform, const Vector2 &topLeft, const Vector2 &bottomRight, float z, const Material &material)
 Draws a filled rectangle with given corner coordinates and z-plane. More...
 
float getTextHeight (const TextFormat &textFormat) const
 Returns the height in pixels of the text from the given text format. More...
 
float getTextTop (const TextFormat &textFormat) const
 Returns the top of the text in a line. More...
 
- Protected Member Functions inherited from kanzi::TextConceptImpl< TDerivedClass >
void prepareTextFormat (const TextFormatParameters &parameters, string text)
 Updates the parameters and text of the internal text format. More...
 
 TextConceptImpl ()=default
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::FontStyleConceptImpl< TDerivedClass >
 FontStyleConceptImpl ()=default
 Constructor. More...
 

Static Protected Member Functions

static Rectangle< float > transformRect (const Matrix3x3 &m, Rectangle< float > rect)
 Transforms a given rectangle with a given matrix. More...
 
static Rectangle< float > transformRect (const Matrix4x4 &m, Rectangle< float > rect)
 Transforms a given rectangle with a given matrix. More...
 

Protected Attributes

ClassPropertyDefaultValue< bool > m_classValueFocusable
 Default value for the Focusable property. More...
 
ClassPropertyDefaultValue< bool > m_classValueHitTestable
 Default value for the Hit Testable property. More...
 
bool m_contentChanged
 Helper flag for editing started and finished messages. More...
 
shared_ptr< TBaseClass > m_cursorNode
 Stores the prefab template instantiated from the CursorPrefabProperty. More...
 
bool m_draggingBegin
 The drag state of the selection cursor for the start selection cursor. More...
 
bool m_draggingEnd
 The drag state of the selection cursor for the end selection cursor. More...
 
bool m_draggingInverted
 Indicates whether the selection start index is after the selection end index in x coordinates when either m_draggingBegin or m_draggingEnd is set to true. More...
 
TextInputManipulatorSharedPtr m_inputManipulator
 The TextInputManipulator attached to the TextBox. More...
 
TextInputLayout m_layoutInfo
 
vector< Node::MessageSubscriptionTokenm_messageTokens
 The following MessageSubscriptionTokens are used for controlling the message subscription while a TextBox is in editing state. More...
 
bool m_panOngoing
 Helper flag for selection change messages. More...
 
MainLoopTimerToken m_passwordEchoTimeoutToken
 Timer subscription token for password echo timeout. More...
 
bool m_revealLastInsertedCharacter
 Whether to show, instead of censoring, the last inserted character in password echo mode. More...
 
shared_ptr< TBaseClass > m_selectionEndNode
 Stores the prefab template instantiated from the SelectionEndPrefabProperty. More...
 
shared_ptr< TBaseClass > m_selectionStartNode
 Stores the prefab template instantiated from the SelectionStartPrefabProperty. More...
 
shared_ptr< TBaseClass > m_textHintNode
 Stores the prefab template instantiated from the TextHintPrefabProperty. More...
 
- Protected Attributes inherited from kanzi::TextConceptImpl< TDerivedClass >
TextFormatPtr m_textFormat
 The text format for the text that this node displays. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::TextBoxConcept
enum  EditMode { EditMode::Automatic, EditMode::Triggered }
 The edit modes. More...
 
- Static Public Attributes inherited from kanzi::TextBoxConcept
static MessageType< TextCompositionStateMessageArgumentsCompositionTextChangedMessage
 Text Box dispatches this message when the composition text is updated by the input methods. More...
 
static MessageType< TextCompositionStateMessageArgumentsCompositionTextCommittedMessage
 Text Box dispatches this message when the composition text is committed to the cached text. More...
 
static MessageType< CursorPositionMessageArgumentsCursorMovedMessage
 Text Box node dispatches this message when the application user moves the cursor in that Text Box node. More...
 
static MessageType< TextChangedMessageArgumentsEditingFinishedMessage
 Text Box node dispatches this message when it leaves the editing state after the application user modifies the text content. More...
 
static MessageType< TextChangedMessageArgumentsEditingStartedMessage
 Text Box node dispatches this message when the application user makes the first modification to the text in that Text Box node. More...
 
static MessageType< EditingStateChangedMessageArgumentsEnteredEditingStateMessage
 Text Box node dispatches this message when it enters the editing state. More...
 
static MessageType< InputMethodActionMessageArgumentsInputMethodActionMessage
 Text Box node dispatches this message when an input method executes the input action assigned to the text box. More...
 
static MessageType< InputMethodAvailableMessageArgumentsInputMethodAvailableMessage
 Text Box node dispatches this message when an input method becomes available. More...
 
static MessageType< InputMethodAvailableMessageArgumentsInputMethodUnavailableMessage
 Text Box node dispatches this message when the composing input method becomes unavailable. More...
 
static MessageType< EditingStateChangedMessageArgumentsLeftEditingStateMessage
 Text Box node dispatches this message when it leaves the editing state. More...
 
static MessageType< SelectedTextMessageArgumentsSelectionChangedMessage
 Text Box node dispatches this message when the application user changes the text selection in that Text Box node. More...
 
static MessageType< CursorPositionMessageArgumentsSelectionClearedMessage
 Text Box node dispatches this message when the application user clears or resets the text selection in that Text Box node. More...
 
static MessageType< SelectedTextMessageArgumentsSelectionStartedMessage
 Text Box node dispatches this message when the application user starts selecting text in that Text Box node. More...
 
static MessageType< TextChangedMessageArgumentsTextChangedMessage
 Text Box node dispatches this message when the application user changes the text in that Text Box node. More...
 
static MessageType< TextCompositionStateMessageArgumentsTextCompositionCanceledMessage
 Text Box dispatches this message when the text composition is canceled. More...
 
static PropertyType< string > DisplayTextProperty
 Reports the text displayed in a Text Box. More...
 
static PropertyType< string > CompositionTextProperty
 Reports the text that the user composes in a Text Box using an input method editor (IME). More...
 
static PropertyType< ResourceSharedPtrSelectionBackgroundBrushProperty
 Sets the brush that highlights selected text. More...
 
static PropertyType< ResourceSharedPtrSelectionForegroundBrushProperty
 Sets the brush for rendering the selected text. More...
 
static PropertyType< ResourceSharedPtrCompositionTextBackgroundBrushProperty
 Sets the brush that highlights the text that the user composes using an input method editor (IME). More...
 
static PropertyType< ResourceSharedPtrCompositionTextForegroundBrushProperty
 Sets the brush that fills the text that the user composes using an input method editor (IME). More...
 
static PropertyType< int > CursorPositionProperty
 Sets the position of the cursor in the text buffer of a Text Box node. More...
 
static PropertyType< int > SelectionStartCursorPositionProperty
 Reports the position of the cursor that marks the beginning of text selection in the text buffer of a Text Box node. More...
 
static PropertyType< int > SelectionEndCursorPositionProperty
 Reports the position of the cursor that marks the end of text selection in the text buffer of a Text Box node. More...
 
static PropertyType< bool > HasSelectionProperty
 Reports whether any of the text in a Text Box node is selected. More...
 
static PropertyType< bool > ReadOnlyProperty
 Sets whether the Text Box node accepts user input. More...
 
static PropertyType< int > MaximumTextLengthProperty
 Sets the maximum allowed text length in a Text Box node. More...
 
static PropertyType< ResourceSharedPtrCursorPrefabProperty
 Sets the prefab template that defines the appearance of the cursor, instead of using the default cursor. More...
 
static PropertyType< ResourceSharedPtrSelectionStartPrefabProperty
 Sets the prefab template that defines the appearance of the selection handle at the beginning of text selection, instead of using the default handle. More...
 
static PropertyType< ResourceSharedPtrSelectionEndPrefabProperty
 Sets the prefab template that defines the appearance of the selection handle at the end of text selection, instead of using the default handle. More...
 
static PropertyType< ResourceSharedPtrTextHintPrefabProperty
 Sets the prefab template that a Text Box node uses to show placeholder content when there is no text content in that Text Box node. More...
 
static PropertyType< bool > HideTextHintWhenEditingProperty
 Sets whether Kanzi hides the placeholder content, which you set using the TextHintPrefabProperty, either: More...
 
static PropertyType< EchoModeEchoModeProperty
 Sets how a Text Box node shows text. More...
 
static PropertyType< InputTypeInputTypeProperty
 Sets the input type of the input methods that provide the input for a Text Box. More...
 
static PropertyType< EditModeEditModeProperty
 Sets the edit mode of a Text Box node. The default value is EditMode::Automatic. More...
 
static PropertyType< bool > IsEditingProperty
 Reports the editing state of a Text Box node. More...
 
static PropertyType< bool > IsComposingTextProperty
 Reports the text composition state of a Text Box node. More...
 
static PropertyType< int > CharacterCountProperty
 Contains the number of characters in a Text Box node. More...
 
static PropertyType< int > WordCountProperty
 Contains the number of words in a Text Box node. More...
 
static PropertyType< int > PasswordEchoTimeoutProperty
 Sets the time in milliseconds that Kanzi shows an inserted character before masking it when using the EchoMode::Password echo mode. More...
 
static PropertyType< string > PasswordMaskingCharacterProperty
 Sets the UTF-8 character that masks each password character when using EchoMode::Password. More...
 
static PropertyType< InputMethodActionInputMethodActionProperty
 Sets the label of the user action button on the on-screen keyboard. More...
 
static PropertyType< TextKeyNavigationDirectionTextKeyNavigationDirectionProperty
 Sets the direction of key navigation for the Text Box node. More...
 
static MessageType< TextContentMessageArgumentsInsertTextAtCursorMessage
 Dispatch this message to insert given text at the cursor position. More...
 
static MessageType< EraseCharactersMessageArgumentsBackspaceAtCursorMessage
 Dispatch this message to erase at the cursor position the previous character in the text string. More...
 
static MessageType< EraseCharactersMessageArgumentsBackspaceWordAtCursorMessage
 Dispatch this message to erase the characters between the cursor position and the previous word boundary in the text string. More...
 
static MessageType< EraseCharactersMessageArgumentsDeleteAtCursorMessage
 Dispatch this message to erase at the cursor position the next character in the text string. More...
 
static MessageType< EraseCharactersMessageArgumentsDeleteWordAtCursorMessage
 Dispatch this message to erase the characters between the cursor position and the next word boundary in the text string. More...
 
static MessageType< MoveCursorMessageArgumentsMoveCursorBackwardMessage
 Dispatch this message to move the cursor backward in a text string. More...
 
static MessageType< MoveCursorMessageArgumentsMoveCursorForwardMessage
 Dispatch this message to move the cursor forward in the text string. More...
 
static MessageType< MoveCursorMessageArgumentsMoveCursorToPreviousWordMessage
 Dispatch this message to move the cursor to the previous word boundary in the text string. More...
 
static MessageType< MoveCursorMessageArgumentsMoveCursorToNextWordMessage
 Dispatch this message to move the cursor to the next word boundary in the text string. More...
 
static MessageType< MoveCursorMessageArgumentsMoveCursorHomeMessage
 Dispatch this message to move the cursor to the beginning of the text string. More...
 
static MessageType< MoveCursorMessageArgumentsMoveCursorToEndMessage
 Dispatch this message to move the cursor to the end of the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionStartForwardMessage
 Dispatch this message to move the handle at the start of text selection forward by one character in the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionStartBackwardMessage
 Dispatch this message to move the handle at the start of text selection backward by one character in the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionStartToNextWordMessage
 Dispatch this message to move the handle at the start of text selection forward to the start of the next word in the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionStartToPreviousWordMessage
 Dispatch this message to move the handle at the start of text selection backward to the start of the previous word in the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionEndForwardMessage
 Dispatch this message to move the handle at the end of text selection forward by one character in the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionEndBackwardMessage
 Dispatch this message to move the handle at the end of text selection backward by one character in the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionEndToNextWordMessage
 Dispatch this message to move the handle at the end of text selection forward to the start of the next word in the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsMoveSelectionEndToPreviousWordMessage
 Dispatch this message to move the handle at the end of text selection backward to the start of the previous word in the text string. More...
 
static MessageType< TextRangeMessageArgumentsSelectTextMessage
 Dispatch this message to select the text between two character indexes in the current text string. More...
 
static MessageType< TextRangeMessageArgumentsDeleteTextMessage
 Dispatch this message to delete the text between two character indexes in the current text string. More...
 
static MessageType< DeleteSelectionMessageArgumentsDeleteSelectionMessage
 Dispatch this message to erase any currently selected text. More...
 
static MessageType< TextInsertionMessageArgumentsInsertTextMessage
 Dispatch this message to insert given text at a given position. More...
 
static MessageType< ModifySelectionMessageArgumentsSelectToHomeMessage
 Dispatch this message to select the text from the beginning of the text string to the cursor position. More...
 
static MessageType< ModifySelectionMessageArgumentsSelectToEndMessage
 Dispatch this message to select the text from the cursor position to the end of the text string. More...
 
static MessageType< ModifySelectionMessageArgumentsClearSelectionMessage
 Dispatch this message to clear the current text selection. More...
 
static MessageType< ModifySelectionMessageArgumentsSelectAllMessage
 Dispatch this message to select all text. More...
 
static MessageType< ModifySelectionMessageArgumentsSelectWordAtCursorMessage
 Dispatch this message to select the word at the current cursor position. More...
 
static MessageType< ModifyEditingStateMessageArgumentsEnterEditingStateMessage
 Dispatch this message to make a Text Box node enter the editing state. More...
 
static MessageType< ModifyEditingStateMessageArgumentsLeaveEditingStateMessage
 Dispatch this message to make a Text Box node leave the editing state. More...
 
static MessageType< TextCompositionStateMessageArgumentsCommitCompositionTextMessage
 Dispatch this message to make a Text Box commit the composition text. More...
 
static MessageType< TextCompositionStateMessageArgumentsCancelTextCompositionMessage
 Dispatch this message to make a Text Box cancel the text composition. More...
 
- Static Public Attributes inherited from kanzi::TextConcept
static PropertyType< ColorRGBAFontColorProperty
 Sets the text color for the default font material and for the materials with a fragment shader that uses the FontColor uniform. More...
 
static PropertyType< ResourceSharedPtrFontMaterialProperty
 Sets the material whose shader is used to render the text in a 3D text node. More...
 
static PropertyType< string > TextProperty
 Sets the text content that a text node renders. More...
 
static PropertyType< TextFormat::TextHorizontalAlignmentTextHorizontalAlignmentProperty
 Sets the horizontal alignment of the text in a text node. More...
 
static PropertyType< TextFormat::TextVerticalAlignmentTextVerticalAlignmentProperty
 Sets the vertical alignment of the text in a text node. More...
 
static PropertyType< Vector2HorizontalPaddingProperty
 Sets the padding spaces between the content and the left and right boundaries of a text node. More...
 
static PropertyType< Vector2VerticalPaddingProperty
 Sets the padding spaces between the content and the top and bottom boundaries of a text node. More...
 
static PropertyType< string > OverflowProperty
 Sets the characters that represent the truncated text when the text string to be rendered is too long to fit in a text node. More...
 
static PropertyType< TextFormat::TruncationTruncationProperty
 Sets how to truncate the text when the text string to be rendered is too long to fit in a node. More...
 
static PropertyType< TextFormat::TruncationDirectionTruncationDirectionProperty
 Sets which part of the text to truncate when the text string to be rendered is too long to fit in a node. More...
 
static PropertyType< bool > RemoveSideBearingsProperty
 Sets the position of the leftmost characters of left-aligned text and rightmost characters of right-aligned text exactly within the boundary of the text node. More...
 
static PropertyType< bool > HorizontalFitProperty
 Allows a Text Block to scale glyphs horizontally when the text string is too long to fit in that Text Block. More...
 
static PropertyType< Vector2HorizontalFitScaleLimitsProperty
 Sets the scale range that the HorizontalFitProperty can use when it scales the text horizontally. More...
 
- Static Public Attributes inherited from kanzi::FontStyleConcept
static PropertyType< float > SizeProperty
 Sets the size for the font in pixels. More...
 
static PropertyType< FontStyleStyleProperty
 Sets the style for the font. More...
 
static PropertyType< FontWeightWeightProperty
 Sets the weight for the font. More...
 
static PropertyType< float > CharacterSpacingProperty
 Sets the character spacing in pixels. More...
 
static PropertyType< float > FixedCharacterWidthProperty
 Overrides the font advance widths and makes each character take a fixed amount of space specified in pixels. More...
 
static PropertyType< float > LineSpacingProperty
 Sets the line spacing in multiples of the normal line height of the selected font. More...
 
static PropertyType< bool > FractionalCharacterWidthProperty
 Sets whether Kanzi uses fractional or rounded character widths to lay out text. More...
 
static PropertyType< bool > SnapCharacterToPixelProperty
 Sets whether Kanzi positions characters in 2D rendering to the nearest pixel: More...
 
static PropertyType< FontHintingPreferenceHintingPreferenceProperty
 Sets the hinting preference of the selected font. More...
 

Detailed Description

template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
class kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >

TextBoxConceptImpl is an abstract class for implementing the Text Box node concept.

The derived TextBox2D and TextBox3D classes supply the rendering of the text input content in 2D and 3D environment.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::TextBoxConceptImpl ( Domain domain,
string_view  name 
)
explicitprotected

Constructor.

Parameters
domainThe UI domain to which the new node belongs.
nameThe name of the node.

Member Function Documentation

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
PropertyTypeEditorInfoSharedPtr kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::makeEditorInfo ( )
static
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
BrushSharedPtr kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getSelectionBackgroundBrush ( ) const
inline

Returns the value of the SelectionBackgroundBrushProperty.

Returns
The brush used to highlight selected text.
See also
setSelectionBackgroundBrush()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setSelectionBackgroundBrush ( BrushSharedPtr  value)
inline

Sets the value of the SelectionBackgroundBrushProperty.

Parameters
valueThe brush used to highlight selected text.
See also
getSelectionBackgroundBrush()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
BrushSharedPtr kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getSelectionForegroundBrush ( ) const
inline

Returns the value of the SelectionForegroundBrushProperty.

Returns
The brush used for rendering the selected text.
See also
setSelectionForegroundBrush()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setSelectionForegroundBrush ( BrushSharedPtr  value)
inline

Sets the value of the SelectionForegroundBrushProperty.

Parameters
valueThe brush used for rendering the selected text.
See also
getSelectionForegroundBrush()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
BrushSharedPtr kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getCompositionBackgroundBrush ( ) const
inline

Returns the value of the CompositionTextBackgroundBrushProperty.

Returns
The brush that highlights the text that the user composes using an input method editor (IME).
See also
setCompositionBackgroundBrush()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setCompositionBackgroundBrush ( BrushSharedPtr  value)
inline

Sets the value of the CompositionTextBackgroundBrushProperty.

Parameters
valueThe brush to use to highlight text that the user composes using an input method editor (IME).
See also
getCompositionBackgroundBrush()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
BrushSharedPtr kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getCompositionForegroundBrush ( ) const
inline

Returns the value of the CompositionTextForegroundBrushProperty.

Returns
The brush that fills the text that the user composes using an input method editor (IME).
See also
setCompositionForegroundBrush()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setCompositionForegroundBrush ( BrushSharedPtr  value)
inline

Sets the value of the CompositionTextForegroundBrushProperty.

Parameters
valueThe brush to use to fill the text that the user composes using an input method editor (IME).
See also
getCompositionForegroundBrush()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
size_t kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getCursorPosition ( )
inline

Returns the value of the CursorPositionProperty.

Returns
The position of the cursor in the text buffer of a Text Box node.
See also
setCursorPosition()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setCursorPosition ( size_t  value)
inline

Sets the value of the CursorPositionProperty.

The function adjusts the cursor position if that falls inside a multi-character glyph.

Parameters
valueThe position of the cursor in the text buffer of a Text Box node.
See also
getCursorPosition()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
bool kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::isReadOnly ( ) const
inline

Returns the value of the ReadOnlyProperty.

Returns
True if a Text Box node is in read-only state.
See also
setReadOnly()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setReadOnly ( bool  value)
inline

Sets the value of the ReadOnlyProperty.

Parameters
valueTrue if a Text Box node is in read-only state.
See also
isReadOnly()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
size_t kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getMaximumTextLength ( ) const
inline

Returns the value of the MaximumTextLengthProperty.

Returns
The maximum allowed text length as UTF-8 characters for a Text Box node. 0 when the limit is not set.
See also
setMaximumTextLength()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setMaximumTextLength ( size_t  value)
inline

Sets the value of the MaximumTextLengthProperty.

Parameters
valueThe maximum allowed text length as UTF-8 characters for a Text Box node. To remove the limit, use 0.
See also
getMaximumTextLength()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
PrefabTemplateSharedPtr kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getCursorPrefab ( ) const
inline

Returns the value of the CursorPrefabProperty.

Returns
The prefab template that a Text Box node uses as the cursor.
See also
setCursorPrefab()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setCursorPrefab ( const PrefabTemplateSharedPtr prefab)
inline

Sets the value of the CursorPrefabProperty.

Parameters
prefabThe prefab template you want to use as the cursor.
See also
getCursorPrefab()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
PrefabTemplateSharedPtr kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getSelectionStartPrefab ( ) const
inline

Returns the value of the SelectionStartPrefabProperty.

Returns
The prefab template that a Text Box node uses as the marker at the start of the selected text.
See also
setSelectionStartPrefab.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setSelectionStartPrefab ( const PrefabTemplateSharedPtr prefab)
inline

Sets the value of the SelectionStartPrefabProperty.

Parameters
prefabThe prefab template that you want to use as the marker at the start of the selected text.
See also
getSelectionStartPrefab()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
PrefabTemplateSharedPtr kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getSelectionEndPrefab ( ) const
inline

Returns the value of the SelectionEndPrefabProperty.

Returns
The prefab template that a Text Box node uses as the marker at the end of the selected text.
See also
setSelectionEndPrefab.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setSelectionEndPrefab ( const PrefabTemplateSharedPtr prefab)
inline

Sets the value of the SelectionEndPrefabProperty.

Parameters
prefabThe prefab template that you want to use as the marker at the end of the selected text.
See also
getSelectionEndPrefab()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
PrefabTemplateSharedPtr kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getTextHintPrefab ( ) const
inline

Returns the value of the TextHintPrefabProperty.

Returns
The prefab template that a Text Box node shows when there is no content in that Text Box node.
See also
setTextHintPrefab().
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setTextHintPrefab ( const PrefabTemplateSharedPtr prefab)
inline

Sets the value of the TextHintPrefabProperty.

Parameters
prefabThe prefab template that you want to show as placeholder content when the Text Box node is empty.
See also
getTextHintPrefab().
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
bool kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::isHideTextHintWhenFocused ( ) const
inline

Returns the value of the HideTextHintWhenEditingProperty.

Returns
If the placeholder content is hidden when the Text Box node is empty and is in editing state, true. If the placeholder content is hidden only when the user enters text in the Text Box node, false.
See also
setHideTextHintWhenFocused(), setTextHintPrefab()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setHideTextHintWhenFocused ( bool  value)
inline

Sets the value of the HideTextHintWhenEditingProperty.

Parameters
valueTo hide the placeholder content when the Text Box node is empty and is in editing state, use true. To hide the placeholder content only when the user enters text in the Text Box node, use false.
See also
isHideTextHintWhenFocused(), getTextHintPrefab()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
EchoMode kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getEchoMode ( ) const
inline

Returns the value of the EchoModeProperty.

Returns
The current echo mode.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setEchoMode ( const EchoMode mode)
inline

Sets the value of the EchoModeProperty.

Parameters
modeThe echo mode to be set.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
InputType kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getInputType ( ) const
inline

Returns the value of the InputTypeProperty.

Returns
The current input type.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setInputType ( const InputType inputType)
inline

Sets the value of the InputTypeProperty.

Parameters
inputTypeThe input type to set.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
EditMode kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getEditMode ( ) const
inline

Returns the value of the EditModeProperty.

Returns
The current edit mode.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setEditMode ( const EditMode mode)
inline

Sets the value of the EditModeProperty.

Parameters
modeThe edit mode to set.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
bool kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::isEditing ( ) const
inline

Returns the value of the IsEditingProperty.

Returns
The editing state.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
bool kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::isComposingText ( ) const
inline

Returns the value of the IsComposingTextProperty.

Returns
Whether the Text Box is in the text composition state.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
size_t kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getCharacterCount ( )
inline

Returns the value of the CharacterCountProperty.

Returns
The number of UTF-8 characters in a Text Box node.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
size_t kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getWordCount ( )
inline

Returns the value of the WordCountProperty.

Returns
The number of words in a Text Box node.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
int kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getPasswordEchoTimeout ( ) const
inline

Returns the value of the PasswordEchoTimeoutProperty.

Returns
The time in milliseconds that an inserted character is displayed before being censored when using the EchoMode::Password echo mode.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setPasswordEchoTimeout ( int  timeout)
inline

Sets the value of the PasswordEchoTimeoutProperty.

Parameters
timeoutThe time in milliseconds that an inserted character is visible before being censored when using the EchoMode::Password echo mode.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
string kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getPasswordMaskingCharacter ( ) const
inline

Returns the value of the PasswordMaskingCharacterProperty.

Returns
The character that masks input characters when using EchoMode::Password echo mode.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setPasswordMaskingCharacter ( string_view  passwordMask)
inline

Sets the value of the PasswordMaskingCharacterProperty.

Parameters
passwordMaskThe character to use to mask the password when using EchoMode::Password echo mode.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
InputMethodAction kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getInputMethodAction ( ) const
inline

Returns the value of the InputMethodActionProperty.

Returns
The value of the input action label.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setInputMethodAction ( InputMethodAction  label)
inline

Sets the value of the InputMethodActionProperty.

Parameters
labelThe input action label value to set.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
TextKeyNavigationDirection kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getTextKeyNavigationDirection ( ) const
inline

Returns the value of the TextKeyNavigationDirectionProperty.

Returns
The value of the text key navigation direction.
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setTextKeyNavigationDirection ( TextKeyNavigationDirection  direction)
inline

Sets the value of the TextKeyNavigationDirectionProperty.

Parameters
directionThe text key navigation direction to set.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::insertText ( size_t  position,
string_view  text 
)

Moves the cursor to a given position and inserts text to that position.

After inserting the text, the cursor is in the end of the inserted text.

Parameters
positionThe position to which you want to insert the text.
textThe text to insert.
See also
setText(), insertTextAtCursor()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveCursorForward ( size_t  distance)

Moves the cursor forward in the text buffer of a Text Box node.

Parameters
distanceThe number of characters to move the cursor in a Text Box node.
See also
moveCursorToEnd(), moveCursorHome(), setCursorPosition(), moveCursorForward(), moveCursorBackward(), moveCursorToNextWord(), moveCursorToPreviousWord()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveCursorBackward ( size_t  distance)

Moves the cursor backward in the text buffer of a Text Box node.

Parameters
distanceThe number of characters to move the cursor in a Text Box node.
See also
moveCursorToEnd(), moveCursorHome(), setCursorPosition(), moveCursorForward(), moveCursorBackward(), moveCursorToNextWord(), moveCursorToPreviousWord()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveCursorToEnd ( )

Moves the cursor to the end of the text buffer of a Text Box node.

See also
moveCursorHome(), setCursorPosition(), moveCursorForward(), moveCursorBackward(), moveCursorToNextWord(), moveCursorToPreviousWord()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveCursorHome ( )

Moves the cursor to the beginning of the text buffer of a Text Box node.

See also
moveCursorToEnd(), setCursorPosition(), moveCursorForward(), moveCursorBackward(), moveCursorToNextWord(), moveCursorToPreviousWord()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionStartForward ( size_t  distance)

Moves the selection start forward in the text buffer of a Text Box node.

Parameters
distanceThe number of characters to move the selection in a Text Box node.
See also
moveSelectionEnd(), moveSelectionEndForward(), moveSelectionEndBackward(), selectText(), moveSelectionStartToNextWord(), moveSelectionStartToPreviousWord()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionStartBackward ( size_t  distance)

Moves the start of text selection backward by a given number of characters in the text buffer of a Text Box node.

Parameters
distanceThe number of characters by which to move the start of text selection backward.
See also
moveSelectionEndForward(), moveSelectionEndBackward(), selectText(), moveSelectionStartToNextWord(), moveSelectionStartToPreviousWord()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionEndForward ( size_t  distance)

Moves the end of text selection forward by a given number of characters in the text buffer of a Text Box node.

Parameters
distanceThe number of characters by which to move the end of text selection forward.
See also
moveSelectionEndForward(), moveSelectionEndBackward(), selectText(), moveSelectionEndToNextWord(), moveSelectionEndToPreviousWord()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionEndBackward ( size_t  distance)

Moves the end of text selection backward by a given number of characters in the text buffer of a Text Box node.

Parameters
distanceThe number of characters by which to move the end of text selection backward.
See also
moveSelectionEndForward(), moveSelectionEndBackward(), selectText(), moveSelectionEndToNextWord(), moveSelectionEndToPreviousWord()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::selectWordAtCursor ( )

Selects the word at the current cursor position.

Word selection is character-based, so cursor position is interpreted to mean character following the cursor. This means that the function can fail, if the cursor is at end of text.

See also
selectWordAt(), selectText(), clearSelection()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::selectWordAt ( size_t  characterPosition)

Selects the word at the specified character position.

Parameters
characterPositionIndex of the character from which to start the selection. Selection expands both ways until the function reaches a word break.
See also
selectWordAtCursor(), selectText(), clearSelection()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::selectText ( size_t  from,
size_t  to 
)

Selects the text between given indexes (cursor positions).

Parameters
fromStart of selection.
toEnd of selection. If selection is successful, the cursor ends up here.
See also
selectWordAtCursor(), selectWordAt(), clearSelection(), getSelectedText(), getSelectionStart(), getSelectionEnd()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::selectAll ( )

Selects all the content in a Text Box node.

This method places the selection start and end cursors at the front and end of the text data.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
bool kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::hasSelection ( ) const

Returns whether any of the text in a Text Box node is selected.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
string kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getSelectedText ( )

Returns the text that is currently selected in the Text Box node.

Returns
The part of the text buffer of a Text Box node that is currently selected.
See also
selectText(), clearSelection(), getSelectionStart(), getSelectionEnd()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
optional< size_t > kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getSelectionStart ( ) const

Returns the start index for the current text selection, or nullopt if no text is selected.

Returns
The start index for the text selection.
See also
selectText(), clearSelection(), getSelectedText()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setSelectionStart ( size_t  index)

Sets the start index for the current selection.

Parameters
indexThe selection start index.
See also
getSelectionStart(), selectText(), clearSelection(), getSelectedText()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
size_t kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getSelectionEnd ( ) const

Returns the end index for the current selection.

Returns
The selection end index. Selection end always matches the cursor position.
See also
setSelectionEnd(), selectText(), clearSelection(), getSelectedText()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setSelectionEnd ( size_t  index)

Sets the end index for the current selection.

Parameters
indexThe selection end index. Selection end always matches the cursor position.
See also
getSelectionEnd(), selectText(), clearSelection(), getSelectedText()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::clearSelection ( )

Clears the current selection.

See also
selectWordAtCursor(), selectWordAt(), selectText(), getSelectedText()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::deleteText ( size_t  begin,
size_t  end 
)

Moves the cursor to position begin and erases UTF-8 characters between positions a\ begin and end.

Parameters
beginThe first UTF-8 character to be erased.
endThe first UTF-8 character not erased.
See also
deleteAtCursor(), backspaceAtCursor()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::deleteSelection ( )

Erases selected text.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
float kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getLineHeight ( )

Returns the line height of the font that the Text Box node uses.

Returns
The line height of the font that the Text Box node uses.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::insertTextAtCursor ( string_view  text)

Inserts text in a Text Box node at the cursor position and moves the cursor forward.

Parameters
textThe text to insert.
See also
setText(), insertText()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::deleteAtCursor ( )

Deletes a character using delete.

For example, in text that uses a left-to-right script this function deletes the character on the right side of the cursor.

See also
deleteText(), backspaceAtCursor()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::deleteWordAtCursor ( )

Deletes the characters between the cursor position and the word boundary that follows the cursor.

Functionally equivalent to the Control + Delete keys.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::backspaceAtCursor ( )

Deletes a character using backspace.

For example, in text that uses a left-to-right script this function deletes the character on the left side of the cursor.

See also
deleteText(), deleteAtCursor()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::backspaceWordAtCursor ( )

Deletes the characters between the cursor position and the closest word boundary using backspace.

For example, in text that uses a left-to-right script this function deletes the characters between the cursor and the word boundary on its left side. Functionally equivalent to the Control + Backspace keys.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveCursorForward ( )

Moves the cursor forward by one character.

See also
setCursorPosition(), moveCursorBackward(), moveCursorToNextWord(), moveCursorToPreviousWord()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveCursorBackward ( )

Moves the cursor backward by one character.

See also
setCursorPosition(), moveCursorForward(), moveCursorToNextWord(), moveCursorToPreviousWord()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionStartForward ( )

Moves the beginning of the text selection forward by one character.

See also
selectText(), moveSelectionStartBackward(), moveSelectionStartToNextWord(), moveSelectionStartToPreviousWord()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionStartBackward ( )

Moves the beginning of the text selection backward by one character.

See also
selectText(), moveSelectionStartForward(), moveSelectionStartToNextWord(), moveSelectionStartToPreviousWord()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionEndForward ( )

Moves the end of the text selection forward by one character.

See also
selectText(), moveSelectionEndBackward(), moveSelectionEndToNextWord(), moveSelectionEndToPreviousWord()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionEndBackward ( )

Moves the end of the text selection backward by one character.

See also
selectText(), moveSelectionEndForward(), moveSelectionEndToNextWord(), moveSelectionEndToPreviousWord()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveCursorToNextWord ( )
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveCursorToPreviousWord ( )
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionStartToNextWord ( )

Moves the beginning of the text selection forward to the next word.

See also
moveSelectionStartToPreviousWord(), selectText(), moveSelectionStartForward(), moveSelectionStartBackward()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionStartToPreviousWord ( )

Moves the beginning of the text selection backward to the previous word.

See also
moveSelectionStartToNextWord(), selectText(), moveSelectionStartForward(), moveSelectionStartBackward()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionEndToNextWord ( )

Moves the end of the text selection forward to the next word.

See also
moveSelectionEndToNextWord(), selectText(), moveSelectionEndForward(), moveSelectionEndBackward()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionEndToPreviousWord ( )

Moves the end of the text selection backward to the previous word.

See also
moveSelectionEndToPreviousWord(), selectText(), moveSelectionEndForward(), moveSelectionEndBackward()
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionEndpointBackward ( size_t  steps)

Moves the active selection end-point backward with steps passed as argument.

Parameters
stepsThe steps to move the active selection end-point backward. If the selection is initiated when you call this function, the selection start position becomes the active selection end-point.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionEndpointForward ( size_t  steps)

Moves the active selection end-point forward with steps passed as argument.

Parameters
stepsThe steps to move the active selection end-point forward. If the selection is initiated when you call this function, the selection end position becomes the active selection end-point.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionEndpointToPreviousWord ( )

Moves the active selection end-point backward to the previous word boundary.

If the selection is initiated when you call this function, the selection start position becomes the active selection end-point.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionEndpointToNextWord ( )

Moves the active selection end-point forward to the previous word boundary.

If the selection is initiated when you call this function, the selection end position becomes the active selection end-point.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionEndpointToFront ( )

Moves the active selection end-point to the front.

If the selection is initiated when you call this function, the selection start position becomes the active selection end-point.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveSelectionEndpointToBack ( )

Moves the active selection end-point to the end of the text.

If the selection is initiated when you call this function, the selection end position becomes the active selection end-point.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::notifyPostPrepareTextFormat ( bool  completeRelayoutingExecuted)

Kanzi calls this function every time it successfully completes the prepareTextFormat function.

Parameters
completeRelayoutingExecutedIndicates whether a complete relayouting of the glyphs was required while preparing the text format.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
string kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getDisplayText ( ) const

Returns a displayable text that Kanzi constructs from the text buffer of the input manipulator owned by the Text Box node, using the kanzi::EchoMode of the Text Box.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
string kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getCompositionText ( ) const

Returns the composition text.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::enterEditingState ( )

Tells a Text Box node to enter the editing state.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::leaveEditingState ( )

Tells a Text Box node to leave the editing state.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::commitCompositionText ( )

Tells a Text Box node to commit the composition text.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::cancelTextComposition ( )

Tells a Text Box node to cancel text composition.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::initialize ( )
protected

TextBoxConceptImpl specific initialization.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onDetached ( )
overrideprotected

Overrides Node::onDetached().

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onInputMethodAvailableChanged ( TextInputManipulator::InputMethodAvailableChangedMessageArguments args)
protected
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onTextChanged ( TextInputManipulator::TextChangedMessageArguments )
protected
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onCompositionTextChanged ( TextInputManipulator::TextCompositionStateMessageArguments )
protected
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onCompositionTextCommitted ( TextInputManipulator::TextCompositionStateMessageArguments )
protected
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onTextCompositionCanceled ( TextInputManipulator::TextCompositionStateMessageArguments )
protected
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onInputMethodsDisconnected ( TextInputManipulator::InputMethodsDisconnectedMessageArguments )
protected

Handles TextInputManipulator::InputMethodDeactivatedMessage.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onCursorMoved ( TextInputManipulator::CursorMovedMessageArguments args)
protected
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onSelectionChanged ( TextInputManipulator::SelectionChangedMessageArguments args)
protected
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onReadOnlyStateChanged ( TextInputManipulator::ReadOnlyStateChangedMessageArguments )
protected
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onInputTypeChanged ( TextInputManipulator::InputTypeChangedMessageArguments )
protected
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onInputAction ( TextInputManipulator::InputMethodActionMessageArguments )
protected
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onNodePropertyChanged ( AbstractPropertyType  propertyType,
PropertyNotificationReason  reason 
)
overrideprotected

Node::onPropertyChanged implementation.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onTextPropertyChanged ( )
protected

Handles the update of the TextProperty.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onEchoModeChanged ( )
protected

Handles the change of the kanzi::EchoMode.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onInputTypePropertyChanged ( )
protected

Handles the change of the kanzi::InputType.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::updateDisplayText ( )
protected

Updates the value of the DisplayTextProperty.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::updateCompositionText ( )
protected

Updates the value of the CompositionTextProperty.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::moveCursorToPoint ( const Vector2 point)
protected

Moves the cursor to a given point.

Parameters
point(X,Y) coordinates of the point to which to move the cursor.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onMultiClick ( const Vector2 clickPoint)
protected

Handles the multi-click gesture on a node.

Selects the word at cursor.

Parameters
clickPointThe click point where the gesture occurred.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onPanMoved ( Vector2  point)
protected

Handles the pan gesture, to drag the cursors including the selection cursors.

Parameters
pointThe active point of a pan gesture.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onPanStarted ( Vector2  clickPoint)
protected

Handles the click begin.

This handles the single click to grab focus and to position the cursor to the click point. A Text Box node gets the focus independent of its edit mode.

Parameters
clickPointThe click point where the gesture occurred.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onPanFinished ( )
protected

Handles pan finishing.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onAboutToLoseFocus ( FocusManager::PreFocusMessageArguments args)
protected

Handler for FocusManager::AboutToLoseFocusMessage.

Parameters
argsThe pre-focus message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onFocusGained ( FocusManager::PostFocusMessageArguments args)
protected

Handler for FocusManager::FocusGainedMessage.

Parameters
argsThe post focus message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::onFocusLost ( FocusManager::PostFocusMessageArguments args)
protected

Handler for FocusManager::FocusLostMessage.

Parameters
argsThe post focus message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleInsertTextAtCursor ( const TextBoxConcept::TextContentMessageArguments args)
protected

Handler for TextBoxConcept::InsertTextAtCursorMessage.

Parameters
argsThe text content message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleBackspaceAtCursor ( const TextBoxConcept::EraseCharactersMessageArguments args)
protected

Handler for TextBoxConcept::BackspaceAtCursorMessage.

Parameters
argsThe erase characters message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleBackspaceWordAtCursor ( const TextBoxConcept::EraseCharactersMessageArguments args)
protected

Handler for TextBoxConcept::BackspaceWordAtCursorMessage.

Parameters
argsThe erase characters message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleDeleteAtCursor ( const TextBoxConcept::EraseCharactersMessageArguments args)
protected

Handler for TextBoxConcept::DeleteAtCursorMessage.

Parameters
argsThe erase characters message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleDeleteWordAtCursor ( const TextBoxConcept::EraseCharactersMessageArguments args)
protected

Handler for TextBoxConcept::DeleteWordAtCursorMessage.

Parameters
argsThe erase characters message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleMoveCursorBackward ( const TextBoxConcept::MoveCursorMessageArguments args)
protected

Handler for TextBoxConcept::MoveCursorBackwardMessage.

Parameters
argsThe move cursor message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleMoveCursorForward ( const TextBoxConcept::MoveCursorMessageArguments args)
protected

Handler for TextBoxConcept::MoveCursorForwardMessage.

Parameters
argsThe move cursor message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleMoveCursorToPreviousWord ( const TextBoxConcept::MoveCursorMessageArguments args)
protected

Handler for TextBoxConcept::MoveCursorToPreviousWordMessage.

Parameters
argsThe move cursor message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleMoveCursorToNextWord ( const TextBoxConcept::MoveCursorMessageArguments args)
protected

Handler for TextBoxConcept::MoveCursorToNextWordMessage.

Parameters
argsThe move cursor message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleMoveCursorHome ( const TextBoxConcept::MoveCursorMessageArguments args)
protected

Handler for TextBoxConcept::MoveCursorHomeMessage.

Parameters
argsThe move cursor message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleMoveCursorToEnd ( const TextBoxConcept::MoveCursorMessageArguments args)
protected

Handler for TextBoxConcept::MoveCursorToEndMessage.

Parameters
argsThe move cursor message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleMoveSelectionStartForward ( const TextBoxConcept::ModifySelectionMessageArguments args)
protected

Handler for TextBoxConcept::MoveSelectionStartForwardMessage.

Parameters
argsThe modify selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleMoveSelectionStartBackward ( const TextBoxConcept::ModifySelectionMessageArguments args)
protected

Handler for TextBoxConcept::MoveSelectionStartBackwardMessage.

Parameters
argsThe modify selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleMoveSelectionStartToNextWordMessage ( TextBoxConcept::ModifySelectionMessageArguments args)
protected

Handler for TextBoxConcept::MoveSelectionStartToNextWordMessage.

Parameters
argsThe modify selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleMoveSelectionStartToPreviousWordMessage ( TextBoxConcept::ModifySelectionMessageArguments args)
protected

Handler for TextBoxConcept::MoveSelectionStartToPreviousWordMessage.

Parameters
argsThe modify selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleMoveSelectionEndForward ( const TextBoxConcept::ModifySelectionMessageArguments args)
protected

Handler for TextBoxConcept::MoveSelectionEndForwardMessage.

Parameters
argsThe modify selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleMoveSelectionEndBackward ( const TextBoxConcept::ModifySelectionMessageArguments args)
protected

Handler for TextBoxConcept::MoveSelectionEndBackwardMessage.

Parameters
argsThe modify selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleMoveSelectionEndToNextWordMessage ( TextBoxConcept::ModifySelectionMessageArguments args)
protected

Handler for TextBoxConcept::MoveSelectionEndToNextWordMessage.

Parameters
argsThe modify selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleMoveSelectionEndToPreviousWordMessage ( TextBoxConcept::ModifySelectionMessageArguments args)
protected

Handler for TextBoxConcept::MoveSelectionEndToPreviousWordMessage.

Parameters
argsThe modify selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleSelectTextMessage ( TextBoxConcept::TextRangeMessageArguments args)
protected

Handler for TextBoxConcept::SelectTextMessage.

Parameters
argsThe text selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleDeleteTextMessage ( TextBoxConcept::TextRangeMessageArguments args)
protected

Handler for TextBoxConcept::DeleteTextMessage.

Parameters
argsThe text selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleDeleteSelectionMessage ( TextBoxConcept::DeleteSelectionMessageArguments args)
protected

Handler for TextBoxConcept::DeleteSelectionMessage.

Parameters
argsThe erase selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleInsertTextMessage ( TextBoxConcept::TextInsertionMessageArguments args)
protected

Handler for TextBoxConcept::InsertTextMessage.

Parameters
argsThe text insertion message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleSelectToHome ( const TextBoxConcept::ModifySelectionMessageArguments args)
protected

Handler for TextBoxConcept::SelectToHomeMessage.

Parameters
argsThe modify selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleSelectToEnd ( const TextBoxConcept::ModifySelectionMessageArguments args)
protected

Handler for TextBoxConcept::SelectToEndMessage.

Parameters
argsThe modify selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleClearSelection ( const TextBoxConcept::ModifySelectionMessageArguments args)
protected

Handler for TextBoxConcept::ClearSelectionMessage.

Parameters
argsThe modify selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleSelectAll ( const TextBoxConcept::ModifySelectionMessageArguments args)
protected

Handler for TextBoxConcept::SelectAllMessage.

Parameters
argsThe modify selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleSelectWordAtCursor ( const TextBoxConcept::ModifySelectionMessageArguments args)
protected

Handler for TextBoxConcept::SelectWordAtCursorMessage.

Parameters
argsThe modify selection message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleEnterEditing ( TextBoxConcept::ModifyEditingStateMessageArguments args)
protected

Handler for TextBoxConcept::EnterEditingStateMessage.

Parameters
argsThe enter editing message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleLeaveEditing ( TextBoxConcept::ModifyEditingStateMessageArguments args)
protected

Handler for TextBoxConcept::LeaveEditingStateMessage.

Parameters
argsThe exit editing message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleCommitCompositionText ( TextBoxConcept::TextCompositionStateMessageArguments args)
protected

Handler for TextBoxConcept::CommitCompositionTextMessage.

Parameters
argsThe commit composition text message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::handleCancelTextComposition ( TextBoxConcept::TextCompositionStateMessageArguments args)
protected

Handler for TextBoxConcept::CancelTextCompositionMessage.

Parameters
argsThe commit composition text message arguments.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
bool kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::hitTestSelectionStart ( Vector2  point) const
protected

Checks whether the point is on the selection starting point surroundings.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
bool kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::hitTestSelectionEnd ( Vector2  point) const
protected

Checks whether the point is on the selection ending point surroundings.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
bool kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::hitTestAfterSelectionEnd ( Vector2  point) const
protected

Checks whether the point is positioned after the point where text selection ends.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
bool kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::hitTestAheadSelectionStart ( Vector2  point) const
protected

Checks whether the point is positioned ahead of the point where text selection starts.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::reloadCursor ( )
protected

Reloads from the CursorPrefabProperty the prefab template that defines the appearance of the cursor.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::reloadSelectionStart ( )
protected

Reloads from the SelectionStartPrefabProperty the prefab template that defines the appearance of the selection handle at the beginning of text selection.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::reloadSelectionEnd ( )
protected

Reloads from the SelectionEndPrefabProperty the prefab template that defines the appearance of the selection handle at the end of text selection.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::reloadTextHint ( )
protected

Reloads from the TextHintPrefabProperty the prefab template for showing placeholder content when the TextBox node is empty.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::updateCharacterCount ( )
protected

Updates the value of the CharacterCountProperty.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::updateWordCount ( )
protected

Updates the value of the WordCountProperty.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
Rectangle< float > kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::transformRect ( const Matrix3x3 m,
Rectangle< float >  rect 
)
staticprotected

Transforms a given rectangle with a given matrix.

If the matrix includes rotation the result is the smallest rectangle without the rotation containing the transformed rectangle.

Parameters
mMatrix used to transform the rectangle.
rectRectangle to transform.
Returns
Transformed rectangle.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
Rectangle< float > kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::transformRect ( const Matrix4x4 m,
Rectangle< float >  rect 
)
staticprotected

Transforms a given rectangle with a given matrix.

If the matrix includes rotation the result is the smallest rectangle without the rotation containing the transformed rectangle.

Parameters
mMatrix used to transform the rectangle.
rectRectangle to transform.
Returns
Transformed rectangle.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::startEditing ( )
protected

Tells a Text Box node to enter the editing state.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::refreshTextHint ( )
protected

Refresh text hint visibility.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::censorRevealedCharacter ( )
protected

Censors the revealed character in password echo mode.

Updates display text. Kanzi uses the method as a timer callback function when password echo timer completes.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::deleteCharactersAtCursor ( int  count)
protected

Deletes a given number of characters at cursor position.

See also
deleteText(), deleteAtCursor(), backspaceAtCursor()
Parameters
countNumber of characters to delete. To delete forwards use positive values, to delete backwards use negative values.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
vector< pair< float, float > > kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::calculateSelectionCoordinates ( ) const
protected

Calculates the individual selection coordinates of a given Text Box node state.

Returns
A vector of selection [begin, end] endpoint coordinate pairs between which the text is selected. For bidirectional text buffer content the vector can contain several selection endpoint pairs. If no text is selected, returns an empty vector.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
vector< pair< float, float > > kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::calculateCompositionHighlightCoordinates ( ) const
protected

Calculates the individual composition text highlight coordinates of a given Text Box node state.

Returns
A vector of selection [begin, end] endpoint coordinate pairs between which the composition text is highlighted. For bidirectional text buffer content the vector can contain several composition text endpoint pairs. If no text composition is detected, returns an empty vector.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
pair< float, float > kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getSelectionEndPoints ( ) const
protected

Returns the selection end point coordinates from the given Text Box node state.

It takes the effective selection start and end points on mixed directional text buffer content.

Returns
The effective start and end points of the selected text in the text buffer.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::setRevealLastInsertedCharacter ( bool  reveal)
protected

Sets whether to reveal the last inserted character in password echo mode.

Some actions, such as erasing text, reset this to false.

Parameters
revealTo show the last inserted character, pass true.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
string kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::getTextForFormatting ( ) const
protected

Returns the m_displayText with added explicit directionality marker if it is a password text.

Returns
Returns the m_displayText and if that text is considered a password text, returns it with the explicit directionality marker.
template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
void kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::updateDraggingStatus ( )
protected

Updates the dragging flags:

Call this method after any update to the selection start or end indices.

template<typename TBaseClass , typename TDerivedClass , typename TTextBoxTraits >
TextConcept::TextFormatParameters kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::createTextFormatParameters ( float  width,
float  height 
) const
protected

Creates the parameters that are needed for initializing the TextFormat of a Text Box node.

Parameters
widthThe available width.
heightThe available height.
Returns
TextFormatParameters suitable for initializing the TextFormat of a Text Box node.
See also
TextConcept::TextFormatParameters

Member Data Documentation

template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
bool kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_revealLastInsertedCharacter
protected

Whether to show, instead of censoring, the last inserted character in password echo mode.

template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
ClassPropertyDefaultValue<bool> kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_classValueHitTestable
protected

Default value for the Hit Testable property.

template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
ClassPropertyDefaultValue<bool> kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_classValueFocusable
protected

Default value for the Focusable property.

template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
shared_ptr<TBaseClass> kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_cursorNode
protected

Stores the prefab template instantiated from the CursorPrefabProperty.

template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
shared_ptr<TBaseClass> kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_selectionStartNode
protected

Stores the prefab template instantiated from the SelectionStartPrefabProperty.

template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
shared_ptr<TBaseClass> kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_selectionEndNode
protected

Stores the prefab template instantiated from the SelectionEndPrefabProperty.

template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
shared_ptr<TBaseClass> kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_textHintNode
protected

Stores the prefab template instantiated from the TextHintPrefabProperty.

template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
TextInputManipulatorSharedPtr kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_inputManipulator
protected

The TextInputManipulator attached to the TextBox.

template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
bool kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_draggingBegin
protected

The drag state of the selection cursor for the start selection cursor.

template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
bool kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_draggingEnd
protected

The drag state of the selection cursor for the end selection cursor.

template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
bool kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_draggingInverted
protected

Indicates whether the selection start index is after the selection end index in x coordinates when either m_draggingBegin or m_draggingEnd is set to true.

template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
bool kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_panOngoing
protected

Helper flag for selection change messages.

template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
bool kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_contentChanged
protected

Helper flag for editing started and finished messages.

template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
vector<Node::MessageSubscriptionToken> kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_messageTokens
protected

The following MessageSubscriptionTokens are used for controlling the message subscription while a TextBox is in editing state.

The subscription tokens are initialized by addMessageHandler and released by removeMessageHandlers.

See also
addMessageHandler(), removeMessageHandler()
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
TextInputLayout kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_layoutInfo
protected
template<typename TBaseClass, typename TDerivedClass, typename TTextBoxTraits>
MainLoopTimerToken kanzi::TextBoxConceptImpl< TBaseClass, TDerivedClass, TTextBoxTraits >::m_passwordEchoTimeoutToken
protected

Timer subscription token for password echo timeout.


The documentation for this class was generated from the following files: